Carbon


StdComment

Header: Quickdraw.h Carbon status: Supported

QuickDraw’s standard low-level function for processing a picture comment.

void StdComment (
    SInt16 kind, 
    SInt16 dataSize, 
    Handle dataHandle
);
Parameter descriptions
kind

The type of comment.

dataSize

The size of additional data, in bytes.

dataHandle

A handle to additional data.

DISCUSSION

If there’s no additional data for the comment, the value of the dataHandle parameter is NULL and the value of the dataSize parameter is 0. The StdComment function simply ignores the comment.

You should only call this low-level function from your customized QuickDraw functions.

SPECIAL CONSIDERATIONS

The StdComment function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)